Create opinionated pull request template #1561
Open
+16
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mcm001
changed the title
Gold856
suggested changes
Nov 12, 2024
Co-authored-by: Gold856 <[email protected]>
Co-authored-by: Jade <[email protected]>
mdurrani808
reviewed
Nov 15, 2024
| - [ ] Pull Request title is [short, imperative summary](https://cbea.ms/git-commit/) of proposed changes | ||
| - [ ] The description documents the _what_ and _why_ | ||
| - [ ] If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedly | ||
| - [ ] If this PR touches configuration, this is backwards compatible with settings back to v2024.3.1 |
There was a problem hiding this comment.
should it be for that year? 2025.X.X or whatever unless this is just intentional to make it always compatible back to then
Co-authored-by: Joseph Eng <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Formalize how pull requests should look, and add a checklist to reduce tribal knowledge around things to watch out for. Having a consistent look to PRs and adding some framework around expectations is helpful for keeping people on the same page, but can also be intimidating. I've attempted to kept this list short and tone friendly.
Meta
Merge checklist:
If this PR touches photon-serde, all messages have been regenerated and hashes have not changed unexpectedlyIf this PR touches configuration, this is backwards compatible with settings back to v2024.3.1If this PR addresses a bug, a regression test for it is added